man: document configured branches
authorJonathan Lebon <jlebon@redhat.com>
Thu, 10 Aug 2017 13:05:15 +0000 (09:05 -0400)
committerAtomic Bot <atomic-devel@projectatomic.io>
Thu, 10 Aug 2017 14:54:03 +0000 (14:54 +0000)
Closes: #1072
Closes: #1073
Approved by: guyshapiro

man/ostree-pull.xml
man/ostree-remote.xml
man/ostree.repo-config.xml

index dd901aa20765104f431ebe3babdc33d49bfde1ff..d78318503358058140d6d371edff5731986bda47 100644 (file)
@@ -132,7 +132,7 @@ Boston, MA 02111-1307, USA.
          This command can retrieve just a specific commit, or go all
          the way to performing a full mirror of the remote
          repository.  If no <literal>BRANCH</literal> is specified,
-         all branches are retrieved.
+         all configured branches are retrieved.
         </para>
 
        <para>
index 2bb8aa71c279d4b2d66ee6148860bc5e7cd217de..bf41a10c0f9521d3c154994cc5e613e1d289e18d 100644 (file)
@@ -96,6 +96,13 @@ Boston, MA 02111-1307, USA.
         <para>
             Changes remote repository configurations.  The NAME refers to the name of the remote.
         </para>
+        <para>
+            The <literal>BRANCH</literal> arguments to the
+            <command>add</command> subcommand specifies the configured branches
+            for the remote. See the <literal>branches</literal> section in
+            <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+            for more information.
+        </para>
         <para>
             The <command>gpg-import</command> subcommand can associate GPG keys to a specific remote repository for use when pulling signed commits from that repository (if GPG verification is enabled).
         </para>
index 90d0f3dcb8a87eefe6307bab0017ded7f1fa1a22..cf0bf7c0a7235f18839c40338496f0031e96e271 100644 (file)
@@ -147,6 +147,13 @@ Boston, MA 02111-1307, USA.
         metadata: summary, static delta "superblocks".</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><varname>branches</varname></term>
+        <listitem><para>A list of strings. Represents the default configured
+        branches to fetch from the remote when no specific branches are
+        requested during a pull operation.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><varname>proxy</varname></term>
         <listitem><para>A string value, if given should be a URL for a